<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArZippable Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArZippable.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classArZippable-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArZippable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Interface to access and modify a specified zip file.  
 <a href="classArZippable.html#details">More...</a></p>

<p><code>#include &lt;ArZippable.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9170cdb5630ef375b7b85c6bf524b600"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9170cdb5630ef375b7b85c6bf524b600"></a>enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>CASE_INSENSITIVE</b> = 2
 }</td></tr>
<tr class="separator:a9170cdb5630ef375b7b85c6bf524b600"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af64b03ccec8f3a286a07638f43a2a1ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af64b03ccec8f3a286a07638f43a2a1ef"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#af64b03ccec8f3a286a07638f43a2a1ef">ModeType</a> { <b>ZIP_MODE</b>, 
<b>UNZIP_MODE</b>
 }<tr class="memdesc:af64b03ccec8f3a286a07638f43a2a1ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modes in which the zip file may be opened. <br /></td></tr>
</td></tr>
<tr class="separator:af64b03ccec8f3a286a07638f43a2a1ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afd19ba1556c9d9c3b39e3699395c1b4b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#afd19ba1556c9d9c3b39e3699395c1b4b">addAll</a> (const char *sourceDir, bool isIncludeSubDirs, bool isOverwrite, const char *password=NULL, int flush=0)=0</td></tr>
<tr class="memdesc:afd19ba1556c9d9c3b39e3699395c1b4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds all of the files in the specified directory to the zip file.  <a href="#afd19ba1556c9d9c3b39e3699395c1b4b">More...</a><br /></td></tr>
<tr class="separator:afd19ba1556c9d9c3b39e3699395c1b4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21d64c766cbc7bc4e13f7509abfd217a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a21d64c766cbc7bc4e13f7509abfd217a">addFile</a> (const char *memberName, bool isOverwrite, const char *sourceFileName, const char *password, int flush=0)=0</td></tr>
<tr class="memdesc:a21d64c766cbc7bc4e13f7509abfd217a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the specified file to the zip file.  <a href="#a21d64c766cbc7bc4e13f7509abfd217a">More...</a><br /></td></tr>
<tr class="separator:a21d64c766cbc7bc4e13f7509abfd217a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99bbf0628efef06c0cd60d3fc2704450"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99bbf0628efef06c0cd60d3fc2704450"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a99bbf0628efef06c0cd60d3fc2704450">ArZippable</a> ()</td></tr>
<tr class="memdesc:a99bbf0628efef06c0cd60d3fc2704450"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a99bbf0628efef06c0cd60d3fc2704450"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57a1ebdf4751a7d54e6776f71ee1ddbc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57a1ebdf4751a7d54e6776f71ee1ddbc"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a57a1ebdf4751a7d54e6776f71ee1ddbc">close</a> ()=0</td></tr>
<tr class="memdesc:a57a1ebdf4751a7d54e6776f71ee1ddbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the zip file. <br /></td></tr>
<tr class="separator:a57a1ebdf4751a7d54e6776f71ee1ddbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0394eedc947a681ea78c9ae3d7859151"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a0394eedc947a681ea78c9ae3d7859151">contains</a> (const char *memberName)=0</td></tr>
<tr class="memdesc:a0394eedc947a681ea78c9ae3d7859151"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether the zip file contains the specified member name.  <a href="#a0394eedc947a681ea78c9ae3d7859151">More...</a><br /></td></tr>
<tr class="separator:a0394eedc947a681ea78c9ae3d7859151"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accff736be8ce7afef3b9697851413196"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#accff736be8ce7afef3b9697851413196">exists</a> () const =0</td></tr>
<tr class="memdesc:accff736be8ce7afef3b9697851413196"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether the zip file exists (according to the file path name)  <a href="#accff736be8ce7afef3b9697851413196">More...</a><br /></td></tr>
<tr class="separator:accff736be8ce7afef3b9697851413196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a836678bb27636d21a9c72d2b4ec259b1"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a836678bb27636d21a9c72d2b4ec259b1">extractAll</a> (const char *destDir, bool isOverwrite, const char *password=NULL)=0</td></tr>
<tr class="memdesc:a836678bb27636d21a9c72d2b4ec259b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts all of the files from the zip file.  <a href="#a836678bb27636d21a9c72d2b4ec259b1">More...</a><br /></td></tr>
<tr class="separator:a836678bb27636d21a9c72d2b4ec259b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a207637636716ff5e3cbc2ac1e569587b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a207637636716ff5e3cbc2ac1e569587b">extractFile</a> (const char *memberName, const char *destDir, bool isOverwrite, const char *destFileName=NULL, const char *password=NULL)=0</td></tr>
<tr class="memdesc:a207637636716ff5e3cbc2ac1e569587b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the specified file from the zip file.  <a href="#a207637636716ff5e3cbc2ac1e569587b">More...</a><br /></td></tr>
<tr class="separator:a207637636716ff5e3cbc2ac1e569587b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c3466016c0f2a1634453aadf72fb9a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c3466016c0f2a1634453aadf72fb9a3"></a>
virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a5c3466016c0f2a1634453aadf72fb9a3">getFilePathName</a> () const =0</td></tr>
<tr class="memdesc:a5c3466016c0f2a1634453aadf72fb9a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the complete file path name of the zip file. <br /></td></tr>
<tr class="separator:a5c3466016c0f2a1634453aadf72fb9a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade910107aa5f3eff321281f3ce13b590"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#ade910107aa5f3eff321281f3ce13b590">open</a> (<a class="el" href="classArZippable.html#af64b03ccec8f3a286a07638f43a2a1ef">ModeType</a> mode)=0</td></tr>
<tr class="memdesc:ade910107aa5f3eff321281f3ce13b590"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens the zip file in the specified mode.  <a href="#ade910107aa5f3eff321281f3ce13b590">More...</a><br /></td></tr>
<tr class="separator:ade910107aa5f3eff321281f3ce13b590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bcdbc19f221b1249babd897c4ee085a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5bcdbc19f221b1249babd897c4ee085a"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArZippable.html#a5bcdbc19f221b1249babd897c4ee085a">~ArZippable</a> ()</td></tr>
<tr class="memdesc:a5bcdbc19f221b1249babd897c4ee085a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a5bcdbc19f221b1249babd897c4ee085a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface to access and modify a specified zip file. </p>
<p><a class="el" href="classArZippable.html" title="Interface to access and modify a specified zip file. ">ArZippable</a> is an abstract base class that defines the methods to add and extract files from a zip file.</p>
<p>An <a class="el" href="classArZippable.html" title="Interface to access and modify a specified zip file. ">ArZippable</a> is expected to be used in a rather "atomic" manner. It can be opened in one of two modes (ZIP_MODE or UNZIP_MODE), and the available operations are subsequently restricted based on the mode: </p><ul>
<li>
ZIP_MODE: <a class="el" href="classArZippable.html#afd19ba1556c9d9c3b39e3699395c1b4b" title="Adds all of the files in the specified directory to the zip file. ">addAll()</a> and <a class="el" href="classArZippable.html#a21d64c766cbc7bc4e13f7509abfd217a" title="Adds the specified file to the zip file. ">addFile()</a> </li>
<li>
UNZIP_MODE: getMemberInfoList(), <a class="el" href="classArZippable.html#a836678bb27636d21a9c72d2b4ec259b1" title="Extracts all of the files from the zip file. ">extractAll()</a>, and <a class="el" href="classArZippable.html#a207637636716ff5e3cbc2ac1e569587b" title="Extracts the specified file from the zip file. ">extractFile()</a> </li>
</ul>
<p>After the files are added to or extracted from the zip file, it should be <a class="el" href="classArZippable.html#a57a1ebdf4751a7d54e6776f71ee1ddbc" title="Closes the zip file. ">close()</a>'ed. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afd19ba1556c9d9c3b39e3699395c1b4b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArZippable::addAll </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>sourceDir</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isIncludeSubDirs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isOverwrite</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>password</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>flush</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds all of the files in the specified directory to the zip file. </p>
<p>The zip file must have been opened in ZIP_MODE.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceDir</td><td>the char * name of the directory from which the files are to be added </td></tr>
    <tr><td class="paramname">isIncludeSubDirs</td><td>a bool set to true if all files in all subdirectories should also be added to the zip file; false otherwise </td></tr>
    <tr><td class="paramname">isOverwrite</td><td>a bool set to true if a file to be added should overwrite an existing zip file member of the same name; false if it should be skipped </td></tr>
    <tr><td class="paramname">password</td><td>an optional char * password to be applied to the addition </td></tr>
    <tr><td class="paramname">flush</td><td>an optional int indication of how the zip file should be flushed when writing (for error recovery); implementation dependent </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool set to true if all files were successfully added (or correctly skipped); false if an error occurred </dd></dl>

</div>
</div>
<a class="anchor" id="a21d64c766cbc7bc4e13f7509abfd217a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArZippable::addFile </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>memberName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isOverwrite</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>sourceFileName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>password</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>flush</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds the specified file to the zip file. </p>
<p>The zip file must have been opened in ZIP_MODE.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">memberName</td><td>the char * name of the member to be added in the zip file </td></tr>
    <tr><td class="paramname">isOverwrite</td><td>a bool set to true if a file to be added should overwrite an existing zip file member of the same name; false if it should be skipped </td></tr>
    <tr><td class="paramname">sourceFileName</td><td>the char * name of the file to be added </td></tr>
    <tr><td class="paramname">password</td><td>an optional char * password to be applied to the addition </td></tr>
    <tr><td class="paramname">flush</td><td>an optional int indication of how the zip file should be flushed when writing (for error recovery); implementation dependent </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool set to true if all files were successfully added (or correctly skipped); false if an error occurred </dd></dl>

</div>
</div>
<a class="anchor" id="a0394eedc947a681ea78c9ae3d7859151"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArZippable::contains </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>memberName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determines whether the zip file contains the specified member name. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">memberName</td><td>the char * name of the member to be found </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool true if the zip file contains the specified member; false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="accff736be8ce7afef3b9697851413196"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArZippable::exists </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determines whether the zip file exists (according to the file path name) </p>
<dl class="section return"><dt>Returns</dt><dd>bool true if the file exists and can be read; false, otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="a836678bb27636d21a9c72d2b4ec259b1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArZippable::extractAll </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>destDir</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isOverwrite</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>password</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Extracts all of the files from the zip file. </p>
<p>The zip file must have been opened in UNZIP_MODE.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">destDir</td><td>the char * name of the directory into which the extracted files are to be placed </td></tr>
    <tr><td class="paramname">isOverwrite</td><td>a bool set to true if an extracted file should overwrite an existing file of the same name in the destination directory; false if it should be skipped </td></tr>
    <tr><td class="paramname">password</td><td>an optional char * password to be applied to the extraction </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool set to true if all files were successfully extracted (or correctly skipped); false if an error occurred </dd></dl>

</div>
</div>
<a class="anchor" id="a207637636716ff5e3cbc2ac1e569587b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArZippable::extractFile </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>memberName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>destDir</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>isOverwrite</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>destFileName</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>password</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Extracts the specified file from the zip file. </p>
<p>The zip file must have been opened in UNZIP_MODE.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">memberName</td><td>the char * name of the file that should be extracted </td></tr>
    <tr><td class="paramname">destDir</td><td>the char * name of the directory into which the extracted files are to be placed </td></tr>
    <tr><td class="paramname">isOverwrite</td><td>a bool set to true if an extracted file should overwrite an existing file of the same name in the destination directory; false if it should be skipped </td></tr>
    <tr><td class="paramname">destFileName</td><td>an optional char * name of the destination file to be written; if NULL, then memberName is used </td></tr>
    <tr><td class="paramname">password</td><td>an optional char * password to be applied to the extraction </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool set to true if the file was successfully extracted (or correctly skipped); false if an error occurred </dd></dl>

</div>
</div>
<a class="anchor" id="ade910107aa5f3eff321281f3ce13b590"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArZippable::open </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classArZippable.html#af64b03ccec8f3a286a07638f43a2a1ef">ModeType</a>&#160;</td>
          <td class="paramname"><em>mode</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Opens the zip file in the specified mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mode</td><td>the ModeType in which the file should be opened </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool true if the zip file was successfully opened in the specified mode; false, otherwise. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ArZippable.h</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArZippable.html">ArZippable</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
